/*
 * Copyright (c) 2014, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.omorphdb.core.storage.document;

import java.io.IOException;

import org.omorphdb.core.value.Value;

/**
 * Each implementation represents a field which should be contained in a
 * {@link Document}.
 * 
 * @author Marco Tamburelli
 * @param <T>
 */
public interface Field<T>
{
	/**
	 * Returns the name representing this field.
	 * 
	 * @return
	 */
	String name();

	/**
	 * Returns the assigned value.
	 * 
	 * @return
	 */
	Value<T> getValue();

	/**
	 * Assign a value
	 * 
	 * @param value
	 * @param updateAware When set to <code>true</code> the update will be
	 *        notified, to inform an index that there was an update. This
	 *        parameter should be <code>false</code> only while a document is
	 *        being created.
	 */
	void setValue(Value<T> value, boolean updateAware);

	/**
	 * Actualizes indexes bound with this field (if there are).
	 * 
	 * @throws IOException
	 */
	void doAfterSave() throws IOException;
}
